[doc] html enhancements #1939
Merged
[doc] html enhancements #1939
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
felixmulder
force-pushed
the
topic/dottydoc-html-enhancements
branch
from
63bdd7b to
5995dd3
Compare
OlivierBlanvillain
approved these changes
Feb 3, 2017
|
@OlivierBlanvillain: agreed :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There were a couple of things missing / forgotten, this is what's fixed in this PR:
[+]symbolTo verify or generate the site, simply clone this branch and issue
sbt genDocs, this will put a site indocs/_site/index.html.Caveats
Constructors are unfortunately not modelled as
defs therefore, their docstrings are lost. This should be fixed in a future PR.Some references that were previously broken, are unfortunately - still broken. This PR does not aim to address this.
Comments to reviewer(s)
I would like to get this in before Monday, so it'd be grrrreat if one of you guys could review this quickly - I don't need reviews from all of you (unless you REALLY REALLY want to ❤️)